Package com.cisco.pt.ipc.system
Interface CepInstance
- All Superinterfaces:
IPCObject
- All Known Subinterfaces:
ScriptModule
- All Known Implementing Classes:
CepInstanceImpl,ScriptModuleImpl
Information provided by the PKI file:
\class CepInstance
\brief CepInstance is the external process (ExApp and Script Module) that communicates with Packet Tracer through the IPC.
\example ipcManager().thisInstance()
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionbooleanInformation provided by the PKI file:voidInformation provided by the PKI file:getCep()Information provided by the PKI file:getExclusivePublisherAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:voidremoveExclusivePublisherAt(int index) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
getInstanceId
UUID getInstanceId()Information provided by the PKI file:
\brief Returns the UUID of this external process. \return uuid, the UUID of this external process.- Returns:
- UUID Returns a UUID
-
getCep
Cep getCep()- Returns:
- Cep Returns a Cep
-
addExclusivePublisher
Information provided by the PKI file:
\brief Returns true if the exclusive publisher with the specified certificate was added successfully, otherwise false. \param pem, the PEM base64-encoded DER certificate string. \return bool, true if the exclusive publisher with the specified certificate was added successfully, otherwise false.- Parameters:
pem- Takes in a parameter of pem- Returns:
- boolean Returns a boolean
-
clearExclusivePublishers
void clearExclusivePublishers()Information provided by the PKI file:
\brief Clears all exclusive publishers. -
removeExclusivePublisher
Information provided by the PKI file:
\brief Returns true if the exclusive publisher with the specified certificate was removed successfully, otherwise false. \param pem, the PEM base64-encoded DER certificate string. \return bool, true if the exclusive publisher with the specified certificate was removed successfully, otherwise false.- Parameters:
pem- Takes in a parameter of pem- Returns:
- boolean Returns a boolean
-
removeExclusivePublisherAt
void removeExclusivePublisherAt(int index) Information provided by the PKI file:
\brief Removes the exclusive publisher at the specified index. \param index, the index of the exclusive publisher.- Parameters:
index- Takes in a parameter of index
-
getExclusivePublisherCount
int getExclusivePublisherCount()Information provided by the PKI file:
\brief Returns the number of exclusive publishers. \return int, the number of exclusive publishers.- Returns:
- int Returns a int
-
getExclusivePublisherAt
Information provided by the PKI file:
\brief Returns the exclusive publisher at the specified index. \param index, the index of the exclusive publisher. \return string, the exclusive publisher at the specified index.- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-
hasExclusivePublisher
Information provided by the PKI file:
\brief Returns true if the specified certificate is an exclusive publisher, otherwise false. \param pem, the PEM base64-encoded DER certificate string. \return bool, Returns true if the specified certificate is an exclusive publisher, otherwise false.- Parameters:
pem- Takes in a parameter of pem- Returns:
- boolean Returns a boolean
-
getCommandLineArg
String getCommandLineArg()Information provided by the PKI file:
\brief Returns the command line argument for this external process (ExApp or Script Module) when launching PT. \return QString, the command line argument fort his external process- Returns:
- String Returns a String
-